home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / kpanelextension.h < prev    next >
Encoding:
C/C++ Source or Header  |  2007-10-08  |  11.0 KB  |  347 lines
  1. /*****************************************************************
  2.  
  3. Copyright (c) 2000 Matthias Elter
  4.  
  5. Permission is hereby granted, free of charge, to any person obtaining a copy
  6. of this software and associated documentation files (the "Software"), to deal
  7. in the Software without restriction, including without limitation the rights
  8. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. copies of the Software, and to permit persons to whom the Software is
  10. furnished to do so, subject to the following conditions:
  11.  
  12. The above copyright notice and this permission notice shall be included in
  13. all copies or substantial portions of the Software.
  14.  
  15. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  18. AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  19. AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  20. CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21.  
  22. ******************************************************************/
  23.  
  24. #ifndef __kpanelextension_h__
  25. #define __kpanelextension_h__
  26.  
  27. class QPopupMenu;
  28. class KConfig;
  29. class KPanelExtensionPrivate;
  30.  
  31. #include <qframe.h>
  32.  
  33. #include <kdelibs_export.h>
  34.  
  35. /**
  36.  * @short %KDE Panel Extension class
  37.  *
  38.  * Panel extensions
  39.  *   @li Are small applications living in the Window Manager dock managed by the panel.
  40.  *   @li Are implemented as DSOs (Dynamic Shared Objects).
  41.  *
  42.  * Note: For security and stability reasons the panel won't load
  43.  * untrusted third party extensions directly into its namespace but via an
  44.  * external wrapper process.
  45.  *
  46.  * The panel locates available extensions by searching for extension desktop
  47.  * files in (ALL_KDEDIRS)/share/apps/kicker/extensions. Every panel extension should
  48.  * install a desktop file there to be recognized by the panel.
  49.  *
  50.  * Besides standard keys like "Name", "Comment" and "Icon" there are
  51.  * two panel extension specific keys:
  52.  *
  53.  * \b X-KDE-Library \n
  54.  *
  55.  * Used by the panel to locate the extension DSO (Dynamic Shared Object)
  56.  * Example: X-KDE-Library=libexampleextension
  57.  *
  58.  * \b X-KDE-UniqueExtension \n
  59.  *
  60.  * Similar to KApplication and KUniqueApplication there are
  61.  * two types of panel extensions. Use unique extensions when it makes no
  62.  * sence to run more than one instance of an extension in the panel. A
  63.  * good example for unique extensions is the taskbar extension.  Use normal
  64.  * extensions when you need instance specific configuration. An example
  65.  * is a subpanel extension where you might want to run more than one instances.
  66.  * X-KDE-UniqueExtension is a boolean key which defaults
  67.  * to "false".  Example: X-KDE-UniqueExtension=true
  68.  *
  69.  * Back to panel extension DSOs, the following conventions are used for KDE:
  70.  * Name:    lib<extensionname>extension.la
  71.  * LDFLAGS: -module -no-undefined
  72.  *
  73.  * To implement a panel extension it is not enough to write a class
  74.  * inheriting from KPanelExtension but you also have to provide a
  75.  * factory function in your DSO.  A sample factory function could look
  76.  * like this:
  77.  *
  78.  * \code
  79.  *
  80.  * extern "C"
  81.  * {
  82.  *     KPanelExtension* init(QWidget *parent, const QString& configFile)
  83.  *     {
  84.  *         KGlobal::locale()->insertCatalogue("exampleextension");
  85.  *         return new ExampleExtension(configFile, KPanelExtension::Normal,
  86.  *                       KPanelExtension::About | KPanelExtension::Help | KPanelExtension::Preferences,
  87.  *                       parent, "exampleextension");
  88.  *     }
  89.  * }
  90.  *
  91.  * \endcode
  92.  *
  93.  * Note: Don't change the factory function signature or the panel will
  94.  * fail to load your extension.
  95.  *
  96.  * @author Matthias Elter <elter@kde.org>
  97.  **/
  98. class KDEUI_EXPORT KPanelExtension : public QFrame
  99. {
  100.     Q_OBJECT
  101.  
  102. public:
  103.  
  104.     /// The type of the extension (TODO)
  105.     enum Type { Normal = 0, Stretch };
  106.     // KDE4: Merge these with KPanelApplet's enums
  107.     /// An action to be taken sometime.
  108.     enum Action { About = 1, Help = 2, Preferences = 4, ReportBug = 8 };
  109.     enum Position { Left = 0, Right, Top, Bottom, Floating };
  110.     enum Alignment { LeftTop = 0, Center, RightBottom };
  111.     /// @since 3.1
  112.     enum Size { SizeTiny = 0, SizeSmall, SizeNormal, SizeLarge, SizeCustom };
  113.  
  114.     /**
  115.      * Constructs a KPanelExtension just like any other widget.
  116.      *
  117.      * @param configFile The configFile handed over in the factory function.
  118.      * @param t The extension type().
  119.      * @param actions Standard RMB menu actions supported by the extension (see action() ).
  120.      * @param parent The pointer to the parent widget handed over in the factory function.
  121.      * @param name A Qt object name for your extension.
  122.      **/
  123.     KPanelExtension(const QString& configFile, Type t = Normal,
  124.          int actions = 0, QWidget *parent = 0, const char *name = 0);
  125.  
  126.     /**
  127.      * Destructor.
  128.      **/
  129.     ~KPanelExtension();
  130.  
  131.     /**
  132.      * Returns the preferred size for a given Position.
  133.      *
  134.      * Every extension should reimplement this function.
  135.      *
  136.      * Depending on the panel position the extensions can choose a preferred size for that
  137.      * location in the Window Manager Dock. Please note that the size can not be larger than the
  138.      * maxsize given by the handler.
  139.      **/
  140.     virtual QSize sizeHint(Position /*p*/, QSize maxsize) const { return maxsize; }
  141.  
  142.     /**
  143.      * Always use this KConfig object to save/load your extensions configuration.
  144.      *
  145.      * For unique extensions this config object will write to a config file called
  146.      * \<extensionname\>rc in the users local KDE directory.
  147.      *
  148.      * For normal extensions this config object will write to a instance specific config file
  149.      * called \<extensionname\>\<instanceid\>rc in the users local KDE directory.
  150.      **/
  151.     KConfig* config() const { return _config; }
  152.  
  153.     /**
  154.      * @return Type indicating the extensions type.
  155.      * Type
  156.      **/
  157.     Type type() const { return _type; }
  158.  
  159.     /**
  160.      * @return int indicating the supported RMB menu actions.
  161.      * Action
  162.      **/
  163.     int actions() const { return _actions; }
  164.  
  165.     /**
  166.      * Generic action dispatcher. Called  when the user selects an item
  167.      * from the extensions RMB menu.
  168.      *
  169.      * Reimplement this function to handle actions.
  170.      *
  171.      * For About, Help, Preferences and ReportBug use the convenience handlers
  172.      * ref about(), help(), preferences(), reportBug()
  173.      *
  174.      **/
  175.     virtual void action( Action a );
  176.  
  177.  
  178.     /**
  179.      * Reimplement this function to set a preferred dock position for your extension.
  180.      * The extension manager will try to place new instances of this extension according
  181.      * to this setting.
  182.      * @return Position
  183.      **/
  184.     virtual Position preferedPosition() const { return Bottom; }
  185.  
  186.     /**
  187.      * @internal
  188.      **/
  189.     void setPosition( Position p );
  190.     /**
  191.      * @internal
  192.      **/
  193.     void setAlignment( Alignment a );
  194.     /**
  195.      * @internal
  196.      * @since 3.1
  197.      **/
  198.     void setSize( Size size, int customSize );
  199.  
  200.     /**
  201.     * @return the extension's size
  202.      * @since 3.1
  203.     **/
  204.     Size sizeSetting() const;
  205.  
  206.     /**
  207.     * @return the custom sizel setting in pixels
  208.      * @since 3.1
  209.     **/
  210.     int customSize() const;
  211.  
  212.     /**
  213.      * @return the extension's custom menu, usually the same as the context menu, or 0 if none
  214.      * @see setCustomMenu(QPopupMenu*)
  215.      * @since 3.4
  216.      */
  217.     QPopupMenu* customMenu() const;
  218.  
  219.     /**
  220.      * @return whether or not to set a desktop geometry claiming strut for this panel
  221.      * defaults to true
  222.      * @see setReservetrut(bool)
  223.      * @since 3.4
  224.      */
  225.     bool reserveStrut() const;
  226.  
  227. signals:
  228.     /**
  229.      * Emit this signal to make the panel relayout all extensions in the dock, when you want
  230.      * to change the extensions size.
  231.      * The panel is going to relayout all extensions based on their preferred size.
  232.      **/
  233.     void updateLayout();
  234.  
  235.     /**
  236.      * Emit this signal to make the panel maintain focus, e.g. don't autohide
  237.      * @since 3.4
  238.      **/
  239.     void maintainFocus(bool);
  240.  
  241. protected:
  242.  
  243.     /**
  244.      * Is called when the user selects "About" from the extensions RMB menu.
  245.      * Reimplement this function to launch a about dialog.
  246.      *
  247.      * Note that this is called only when your extension supports the About action.
  248.      * See Action.
  249.      **/
  250.     virtual void about() {}
  251.  
  252.     /**
  253.      * Is called when the user selects "Help" from the extensions RMB menu.
  254.      * Reimplement this function to launch a manual or help page.
  255.      *
  256.      * Note that this is called only when your extension supports the Help action.
  257.      * See Action.
  258.      **/
  259.     virtual void help() {}
  260.  
  261.     /**
  262.      * Is called when the user selects "Preferences" from the extensions RMB menu.
  263.      * Reimplement this function to launch a preferences dialog or kcontrol module.
  264.      *
  265.      * Note that this is called only when your extension supports the preferences action.
  266.      * See Action.
  267.      **/
  268.     virtual void preferences() {}
  269.  
  270.     /**
  271.      * Is called when the user selects "Report bug" from the applet's RMB menu.
  272.      * Reimplement this function to launch a bug reporting dialog.
  273.      *
  274.      * Note that this is called only when your applet supports the ReportBug
  275.      * action.
  276.      * See Action.
  277.      **/
  278.     virtual void reportBug() {}
  279.  
  280.     /**
  281.      * @return the extension's position. (left, right, top, bottom)
  282.      **/
  283.     Position position() const { return _position; }
  284.  
  285.     /**
  286.      * @return the extension's alignment. (left/top, center, or right/bottom)
  287.      **/
  288.     Alignment alignment() const { return _alignment; }
  289.  
  290.     /**
  291.      * @return the extensions orientation. (horizontal or vertical)
  292.      **/
  293.     Orientation orientation();
  294.  
  295.     /**
  296.      * @return the appropriate size in pixels for the panel
  297.      * @since 3.1
  298.      */
  299.     int sizeInPixels() const;
  300.  
  301.     /**
  302.      * This extension has changed its position.
  303.      * Reimplement this change handler in order to adjust the look of your
  304.      * applet.
  305.      **/
  306.     virtual void positionChange( Position ) {}
  307.  
  308.     /**
  309.      * This extension has changed its alignment.
  310.      * Reimplement this change handler in order to adjust the look of your
  311.      * applet.
  312.      **/
  313.     virtual void alignmentChange( Alignment ) {}
  314.  
  315.     /**
  316.      * Use this method to set the custom menu for this extensions so that it can be shown
  317.      * at the appropriate places/times that the extension many not itself
  318.      * be aware of. The extension itself is still responsible for deleting and managing the
  319.      * the menu.
  320.      *
  321.      * If the menu is deleted during the life of the extension, be sure to call this method again
  322.      * with the new menu (or 0) to avoid crashes
  323.      * @since 3.4
  324.      */
  325.     void setCustomMenu(QPopupMenu*);
  326.  
  327.     /**
  328.      * Use this method to set the return value for reserveStrut
  329.      * @see reserveStrut
  330.      * @since 3.4
  331.      */
  332.     void setReserveStrut(bool shouldUseStrut);
  333.  
  334. private:
  335.     Type                 _type;
  336.     Position             _position;
  337.     Alignment            _alignment;
  338.     KConfig*             _config;
  339.     int                  _actions;
  340. protected:
  341.     virtual void virtual_hook( int id, void* data );
  342. private:
  343.     KPanelExtensionPrivate     *d;
  344. };
  345.  
  346. #endif
  347.